/*---------------------------------------------------------------------------*\
  		  _______  ____    ____  ________  
 		 |_   __ \|_   \  /   _||_   __  | 
   		   | |__) | |   \/   |    | |_ \_| 
   		   |  ___/  | |\  /| |    |  _|    
    		  _| |_    _| |_\/_| |_  _| |_     
   		 |_____|  |_____||_____||_____|    
   	     Copyright (C) Toulouse INP, Pierre Horgue

License
    This file is part of porousMultiphaseFoam, an extension of OpenFOAM
    developed by Pierre Horgue (phorgue@imft.fr) and dedicated to multiphase 
    flows through porous media.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::fv::JacobianMatrix

Description
    Class for handling jacobian matrix

SourceFiles
    JacobianMatrix.C

\*---------------------------------------------------------------------------*/

#ifndef JacobianMatrix_H
#define JacobianMatrix_H

#include "volFields.H"
#include "fvScalarMatrix.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

/*---------------------------------------------------------------------------*\
                       Class JacobianMatrix Declaration
\*---------------------------------------------------------------------------*/

class JacobianMatrix
{
    
protected:

    const fvMesh& mesh_;
    fvScalarMatrix matrix_;

    //- List for direct dFx/dVx storage in jacobian matrix
    labelListList lowerListM_, upperListM_, lowerListF_, upperListF_;

    void constructAddressing();
    
public:

    // Constructors

        //- Construct from field
    JacobianMatrix(const volScalarField& vf);

    virtual ~JacobianMatrix();

    //- Members
    fvScalarMatrix& matrix()
        {
            return matrix_;
        }
    
    void storeColumn(const volScalarField& dF, label celli);
};

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //
